.TH "UNICORN" "3" "Jan 27th 2025" "Unicorn 1.0.4"
.SH NAME
uniweighting \- collation weighting algorithm
.SH LIBRARY
Embeddable Unicode Algorithms (libunicorn, -lunicorn)
.SH SYNOPSIS
.nf
.B #include <unicorn.h>
.PP
.B enum uniweighting {
.RS
.B UNI_NON_IGNORABLE,
.B UNI_SHIFTED,
.RE
.B };
.fi
.SH DESCRIPTION
This enumeration defines constants representing the possible options for variable weighted characters.
.PP
The Unicode Collation Algorithm defines the collation for some characters as variable.
This typically includes punctuation characters and symbols.
Based on the variable-weighting setting, these characters can be interpreted as having a \f[B]UNI_QUATERNARY\f[R].
.SH CONSTANTS
.TP
.BR UNI_NON_IGNORABLE
The words with hyphen-minus or hyphen are grouped together, but before all letters in the third position.
This is because they are not ignorable, and have primary values that differ from the letters.
The symbols ☠ and ♡ have primary differences.
.TP
.BR UNI_SHIFTED
The hyphen-minus and hyphen are grouped together, and their differences are less significant than the casing differences in the letter “l”.
This grouping results from the fact that they are ignorable, but their fourth level differences are according to the original primary order, which is more intuitive than Unicode order.
The symbols ☠ and ♡ are ignored on levels 1-3.
.SH SEE ALSO
.BR unistrength (3)
.SH AUTHOR
.UR https://railgunlabs.com
Railgun Labs
.UE .
.SH INTERNET RESOURCES
The online documentation is published on the
.UR https://railgunlabs.com/unicorn
Railgun Labs website
.UE .
.SH LICENSING
Unicorn is distributed with its end-user license agreement (EULA).
Please review the agreement for information on terms & conditions for accessing or otherwise using Unicorn and for a DISCLAIMER OF ALL WARRANTIES.
